// Copyright (c) 2008-2010, Arne Claus
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the 
// following conditions are met:
//
// - Redistributions of source code must retain the above copyright notice, this list of conditions and the following 
//   disclaimer.
// - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following 
//   disclaimer in the documentation and/or other materials provided with the distribution.
// - Neither the name Arne Claus nor the names of any contributors may be used to endorse or promote products
//   derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE 
// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef __INCLUDED_CBL_THREAD_H__
#define __INCLUDED_CBL_THREAD_H__

#include "CBL_Defines.h"
#include "CBL_Locks.h"
#include "CBL_PooledObject.h"

CB_SUBNAMESPACE_START(Cpu)

class CThread
{
public:
	
	BASELIB_API CThread(const char* _pName=NULL, uint32 _Granularity=100);
	BASELIB_API virtual ~CThread();	
	
public:
	
    //! \brief  Starts a thread that runs until stoped in timesteps defined by Granularity
    //! \param  _pData will be passed to Tick
	BASELIB_API void Run(void* _pData=NULL);
    
    //! \brief  Starts a thread with only one iteration
    //! \param  _pData will be passed to Tick
    BASELIB_API void RunOnce(void* _pData=NULL);
    
    //! \brief  Waits for the thread to finish.
    //! \detail If the thread is paused it has to be resumed manually.
    BASELIB_API void Join();
    
    //! \brief  Combination of Resume() and Join()
    BASELIB_API void Stop();
    
    //! \brief  Pauses a looped thread.
    //! \detail Pause can be called before and after a thread finished and will always effect 
    //!			only the next run cycle.
    //!         Subsequent calls have no additional effect.
    //! 		Pause will wait for the current loop to finish.
	BASELIB_API void Pause();
    
    //! \brief  Resumes a paused thread.
    //!         Subsequent calls have no additional effect.
    //! 		Resume will wait for the current loop to finish.
	BASELIB_API void Resume();
    
    //! \detail Note that the return value might changed directly after the function is being called.
    //!			So only use in loops or other "safe" scenarios.
    //! 		IsPaused will wait for the current loop to finish.
	//! \return True if the thread is/will be paused.
    BASELIB_API bool IsPaused();

protected:
	
	//! \brief Overload this function
	//! \param _pData is passed by the Run() method
	virtual void Tick(void* _pData) = 0;
 
private:
	
	struct SThreadParameters : public Memory::CPooledObject
	{
    	uint32  m_Granularity;
        bool    m_Once;
		void    *m_pData;
		CThread *m_pObject;
	};
	
private:

#ifdef CB_WINDOWS
	static DWORD WINAPI ThreadMain(LPVOID _pParams);
#else
	static void* ThreadMain(void* _pParams);
#endif
	
private:
	
    uint32      m_Granularity;
	bool        m_Paused;
	bool		m_Running;
	const char* m_pName;
    
    CMutex      m_RunMutex;
    CMutex      m_PauseMutex;
	
#ifdef CB_WINDOWS
	HANDLE m_Thread;
	DWORD  m_ThreadId;
#else
	pthread_t m_ThreadId;
#endif 
};

CB_SUBNAMESPACE_END

#endif